Summary
Search result for categories searches the Content Studio full-text index and builds a table with the resulting matches. The component receives data from the Search form component that can be placed on the same page or on another page.
| Category | AS Search |
| Version | 1.0 |
| Complies with Xhtml 1.0 / 1.1 rules | Yes |
| Supported server programming languages | C# Visual Basic.NET |
| Output content type | block |
When to use
This component is typically used to display the search result after a fulltext search operation.
Programming interface
Parameters
- Search filters
- Categories
- A collection of categories to search in. If this list is empty the unit list will determine the search scope instead.
- Units
- A collection of units to search in, only categories in these units that are marked as searchable will be included in the search. This collection is ignored if any categories is specified. Leave both collections empty will search among searchable categories in the entire site.
- General control properties
- QueryName
- Name of the querystring member that contains the search criteria
- UniqueID
- A name that identifies the component on a page. Please make sure that each control instance on a page has its own unique name.
- Handle posted pages
- Indicates how the component should handle posted data.
- PTID
- The id of a presentation template to use. This parameter is not required.
- MaxReturnSize
- Set to a numeric value greater than 10 to limit the size of the returned result. Values below 10 or nonnumeric values defaults to 200 chacters.
- Messages
- ResultStr0
- The message to show if the search condition could not be evaluated.
- ResultStr1
- The first portion of the summary text displayed if no data could be found. This value will be followed by the entered criteria.
- ResultStr2
- The end portion of the summary text if no data could be found.
- ResultStr3
- The first portion of the summary text when data has been found.
- Table formatting options and properties
- Table border
- The width in pixels of the border of the generated data table.
- Cell padding
- The cell padding of the generated table's cells. This is the distance (in pixels) between the the cell edges and its content.
- Table cell spacing
- The cell spacing of the generated table's cells. This is the distance (in pixels) between two cells.
- Width of the table
- The relative or absolute width of the generated data table.
- Table class name
- The CSS class name associated with the generated table. This value can be empty.
- Table summary
- The summary attribute of the generated table. The default value is an empty string which omits the attribute. Omitting this attribute causes xhtml 1.0 strict or higher validators to generate warnings.
- Table attributes
- Optional extra attributes attributes in the table.
- Returned data properties
- Background colour of uneven rows
- Background colour of uneven rows. This can be a colour code value such as "#FFFFFF" or a valid name like "White".
- Background colour of even rows.
- Background colour of even rows. This can be a colour code value such as "#FFFFFF" or a valid name like "White".
- Link attributes
- Optional attributes in the generated links.
- Link separator text
- Separator between each generated link.
- Link target
- Target of each generated link. Normally this value is omitted.
- Column definitions and properties
- Column properties
- Defines one or more col elements connected to the generated table. These regulates th.e properties for an entire data column in the table.
- SortableColumns
- Makes it possible for users to sort the search result. Normally the result is search according to relevance.
- HideIntroduction
- Hide introduction field in the returned data.
- DisplayRelevance
- Display the relevance column. Relevance is indicated as 5 - 1 where the most relevant matches are given 5.
- DisplayLogicalPath
- Displays the logical path column.
- DisplayCreatedDate
- Displays the created date column.
- Date formatting string
- Format string for date-time values. This value is defined in .NET DateTimeFormatInfo class. Popular formats are "g" (general short date and short time) and "yy-MM-dd HH:mm" which is another short format. An empty value renders the system's standard format.
- Document column label
- Document column label
- Relevance column label
- Relevance column label
- Logical path column label
- Logical path column label
- Created date column label
- Created date column label
- Extended search result properties
- UseExtendedSearchResult
- Use extended search result. Displays a short summary of found text. Requires an extended search result license
- ExtendedSearchResultClassName
- Optional class name for extended search result. This indicates the formatting of the highlighted text.
- ReturnFieldsInExtendedSearchResult
- Type the name of xml-fields you want to return in extended search result. Use "," (comma) as a separator. Ex: Title,Content,HTMLText
- Position of page range links
- Place pageing on bottom
- Use pageing links on the bottom of the generated table.
- Place pageing on top
- Use pageing links on top of the generated table.
- Page range properties
- Page size
- The maximum number of documents to list on each data page. 0 = All documents
- Range size
- The size (in number of page links) of page range.
- Leading page range text
- A descriptive text to show before the generated page range links.
- Link prefix text
- A short text to be displayed in a link to a new page in the range. This text is combined with the page number. Ex. "page " will generate "page 1 page 2".
- Previous page range text
- The text to display in the link that navigates to the previous page range.
- Previous page text
- The text to display in the link that navigates to the previous page in the range.
- Next page text
- The text to display in the link that navigates to the next page in the range.
- Next page range text
- The text to display in the link that navigates to the next page range.
- RankAltText
- Alternative leading text for ranking images
- Properties for extended functionality in SQL Server 2005 and later
- Search language
- A language that should be used for lexical matching of the search criteria. The default value is Default which instructs the fulltext engine to use the language of the underlying index. The languages Danish, Polish, Portuguese-Brazil, Portuguese-Portugal, Russian, and Turkish languages must be manually enabled for full-text indexing. For more information about how to enable these languages, see Knowledge Base article 908441 at Microsoft Help and Support.
- Search method
- The method used by the search engine. Contains is the method used in previous versions of the product. The new Freetext method can identify forms of words such as friend and friends and even synonyms while Contains needs wildcards in order to accomplish the same behaviour. However Freetext does not support any logocal operator such as NEAR, OR AND. For this reason Freetext is best suited for standard searching while Contains is best for advanced search functionality.
- Do not check permissions
- Instructs the search engine to omit permissions check. This makes the search operation perform better but can return documents that the caller is not permitted to read, thus use this property with care.
- Do check publishing date
- Instructs the search engine to ignore the publishing date check thus returning archived or un-published documents along with published documents. This can improve performance but can easily result in unexpected behaviour.
Remarks
Starting with version 5.1 customers running Content Studio on Sql Server 2005 and later can use the new Freetext option and the new performance optimization in the underlying database implentation. Also, starting with version 5.1 the Extended Search result is now included in all versions of the procuct and no longer requires a separate license.